/*
   Copyright 2009 Abdulla Abdurakhmanov (abdulla@latestbit.com)
   Original sources are available at www.latestbit.com

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package org.latestbit.smartobjects;

import org.latestbit.smartobjects.exceptions.SmartBusSystemException;
import org.latestbit.smartobjects.network.*;

/**
 * Base callback interface for asynchronous server implementations. 
 * Interface used for asynchronous reply for incoming request 
 * for async server implementations.  
 * @author abdulla-a
 *
 */
public interface IAsyncServerCallback {
	/**
	 * Gets operation name/id of this callback instance
	 * @return Operation name/id
	 */
	String getOperationName();
	
	/**
	 * Gets original client request of this callback instance
	 * @return original client request
	 */
	INetworkCommand getRequest();
	
	/**
	 * Gets request context for incoming original request of this callback instance
	 * @return Request context for original client request
	 */
	RequestContext getRequestContext();
	
	/**
	 * Sends system exception as reply to original client request
	 * @param ex System exception
	 */
	void sendSystemException ( SmartBusSystemException ex );
}
